home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3dm / fx / dmPMSetupVideoTransition.z / dmPMSetupVideoTransition
Encoding:
Text File  |  2002-10-03  |  13.5 KB  |  199 lines
  1.  
  2.  
  3.  
  4. ddddmmmmPPPPMMMMSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn((((3333ddddmmmm))))                    ddddmmmmPPPPMMMMSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn((((3333ddddmmmm))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ddddmmmmPPPPMMMMSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn, ddddmmmmPPPPMMMMEEEExxxxeeeeccccuuuutttteeeeVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn,
  10.      ddddmmmmPPPPMMMMCCCClllleeeeaaaannnnuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn, ddddmmmmPPPPMMMMBBBBuuuuffffffffeeeerrrrSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn,
  11.      ddddmmmmPPPPMMMMBBBBuuuuffffffffeeeerrrrEEEExxxxeeeeccccuuuutttteeeeVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn - sets up, executes, and cleanups video
  12.      transitions
  13.  
  14.  
  15. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  16.      ####iiiinnnncccclllluuuuddddeeee <<<<ddddmmmmeeeeddddiiiiaaaa////ffffxxxx____pppplllluuuuggggiiiinnnn____mmmmggggrrrr....hhhh>>>>
  17.  
  18.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmPPPPMMMMSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn
  19.            (((( DDDDMMMMeeeeffffffffeeeecccctttt**** eeeeffffffffeeeecccctttt,,,,
  20.              vvvvooooiiiidddd ****ssssrrrrccccAAAA,,,,
  21.              DDDDMMMMppppaaaarrrraaaammmmssss ****ssssrrrrccccAAAAPPPPaaaarrrraaaammmmssss,,,,
  22.              vvvvooooiiiidddd ****ssssrrrrccccBBBB,,,,
  23.              DDDDMMMMppppaaaarrrraaaammmmssss ****ssssrrrrccccBBBBPPPPaaaarrrraaaammmmssss,,,,
  24.              uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt ppppaaaarrrrtttt,,,,
  25.              uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt ttttoooottttaaaallll ))))
  26.  
  27.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmPPPPMMMMEEEExxxxeeeeccccuuuutttteeeeVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn
  28.            (((( DDDDMMMMeeeeffffffffeeeecccctttt**** eeeeffffffffeeeecccctttt,,,,
  29.              vvvvooooiiiidddd ****ssssrrrrccccAAAA,,,,
  30.              DDDDMMMMppppaaaarrrraaaammmmssss ****ssssrrrrccccAAAAPPPPaaaarrrraaaammmmssss,,,,
  31.              vvvvooooiiiidddd ****ssssrrrrccccBBBB,,,,
  32.              DDDDMMMMppppaaaarrrraaaammmmssss ****ssssrrrrccccBBBBPPPPaaaarrrraaaammmmssss,,,,
  33.              vvvvooooiiiidddd ****ddddsssstttt,,,,
  34.              DDDDMMMMppppaaaarrrraaaammmmssss ****ddddssssttttPPPPaaaarrrraaaammmmssss,,,,
  35.              uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt ppppaaaarrrrtttt,,,,
  36.              uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt ttttoooottttaaaallll ))))
  37.  
  38.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmPPPPMMMMCCCClllleeeeaaaannnnuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn
  39.            (((( DDDDMMMMeeeeffffffffeeeecccctttt**** eeeeffffffffeeeecccctttt ))))
  40.  
  41.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmPPPPMMMMBBBBuuuuffffffffeeeerrrrSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn
  42.            (((( DDDDMMMMeeeeffffffffeeeecccctttt**** eeeeffffffffeeeecccctttt,,,,
  43.              DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr ****ssssrrrrccccAAAABBBBuuuuffffffffeeeerrrr,,,,
  44.              DDDDMMMMppppaaaarrrraaaammmmssss ****ssssrrrrccccAAAAPPPPaaaarrrraaaammmmssss,,,,
  45.              DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr ****ssssrrrrccccBBBBBBBBuuuuffffffffeeeerrrr,,,,
  46.              DDDDMMMMppppaaaarrrraaaammmmssss ****ssssrrrrccccBBBBPPPPaaaarrrraaaammmmssss,,,,
  47.              uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt ppppaaaarrrrtttt,,,,
  48.              uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt ttttoooottttaaaallll ))))
  49.  
  50.      DDDDMMMMssssttttaaaattttuuuussss ddddmmmmPPPPMMMMBBBBuuuuffffffffeeeerrrrEEEExxxxeeeeccccuuuutttteeeeVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn
  51.            (((( DDDDMMMMeeeeffffffffeeeecccctttt**** eeeeffffffffeeeecccctttt,,,,
  52.              DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr ****ssssrrrrccccAAAABBBBuuuuffffffffeeeerrrr,,,,
  53.              DDDDMMMMppppaaaarrrraaaammmmssss ****ssssrrrrccccAAAAPPPPaaaarrrraaaammmmssss,,,,
  54.              DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr ****ssssrrrrccccBBBBBBBBuuuuffffffffeeeerrrr,,,,
  55.              DDDDMMMMppppaaaarrrraaaammmmssss ****ssssrrrrccccBBBBPPPPaaaarrrraaaammmmssss,,,,
  56.              DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr ****ddddssssttttBBBBuuuuffffffffeeeerrrr,,,,
  57.              DDDDMMMMppppaaaarrrraaaammmmssss ****ddddssssttttPPPPaaaarrrraaaammmmssss,,,,
  58.              uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt ppppaaaarrrrtttt,,,,
  59.              uuuunnnnssssiiiiggggnnnneeeedddd iiiinnnntttt ttttoooottttaaaallll ))))
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ddddmmmmPPPPMMMMSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn((((3333ddddmmmm))))                    ddddmmmmPPPPMMMMSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn((((3333ddddmmmm))))
  71.  
  72.  
  73.  
  74. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  75.      _e_f_f_e_c_t       A pointer to a DDDDMMMMeeeeffffffffeeeecccctttt, which was returned from
  76.                   ddddmmmmPPPPMMMMCCCCrrrreeeeaaaatttteeeeEEEEffffffffeeeecccctttt.
  77.  
  78.      _s_r_c_A         A pointer to the video source image for track A.
  79.  
  80.      _s_r_c_A_P_a_r_a_m_s   The source (track A) parameter/value list, a pointer to
  81.                   DDDDMMMMppppaaaarrrraaaammmmssss, can be created with ddddmmmmPPPPaaaarrrraaaammmmssssCCCCrrrreeeeaaaatttteeee.
  82.  
  83.      _s_r_c_B         A pointer to the video source image for track B.
  84.  
  85.      _s_r_c_B_P_a_r_a_m_s   The source (trackB) parameter/value list, a pointer to
  86.                   DDDDMMMMppppaaaarrrraaaammmmssss, can be created with ddddmmmmPPPPaaaarrrraaaammmmssssCCCCrrrreeeeaaaatttteeee.
  87.  
  88.      _p_a_r_t         Goes from 0 to _t_o_t_a_l (inclusive).
  89.  
  90.      _t_o_t_a_l        The total number of frames.
  91.  
  92.      _d_s_t          A pointer to the video destination image.
  93.  
  94.      _d_s_t_P_a_r_a_m_s    The destination parameter/value list, a pointer to DDDDMMMMppppaaaarrrraaaammmmssss,
  95.                   can be created with ddddmmmmPPPPaaaarrrraaaammmmssssCCCCrrrreeeeaaaatttteeee.
  96.  
  97.      _s_r_c_A_B_u_f_f_e_r   A pointer to a DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr for the source (track A), which
  98.                   was returned from dmFXAllocateImageBuffers.
  99.  
  100.      _s_r_c_B_B_u_f_f_e_r   A pointer to a DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr for the source (track B), which
  101.                   was returned from dmFXAllocateImageBuffers.
  102.  
  103.      _d_s_t_B_u_f_f_e_r    A pointer to a DDDDMMMMffffxxxxbbbbuuuuffffffffeeeerrrr for the destination, which was
  104.                   returned from dmFXAllocateImageBuffers.
  105.  
  106.  
  107. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  108.      Video transitions may have user customizable settings in the form of a
  109.      dialog box.  Calling ddddmmmmPPPPMMMMSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn allows the video transition
  110.      plugin to post the dialog and query values from the user.  Because all
  111.      plugins must have default values, calling ddddmmmmPPPPMMMMSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn is
  112.      optional.  Calling ddddmmmmPPPPMMMMEEEExxxxeeeeccccuuuutttteeeeVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn will cause the video
  113.      transition to be executed on your video clips.
  114.      ddddmmmmPPPPMMMMCCCClllleeeeaaaannnnuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn does not normally need to be called directly
  115.      from your application.
  116.  
  117.  
  118. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEESSSS
  119.      ddddmmmmPPPPMMMMSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn will return DM_SUCCESS if successful, or will
  120.      return DM_FAILURE if it fails.  ddddmmmmPPPPMMMMEEEExxxxeeeeccccuuuutttteeeeVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn will return
  121.      DM_SUCCESS if successful, or will return DM_FAILURE if it fails.
  122.      ddddmmmmPPPPMMMMCCCClllleeeeaaaannnnuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn will return DM_SUCCESS if successful, or will
  123.      return DM_FAILURE if it fails.  ddddmmmmPPPPMMMMBBBBuuuuffffffffeeeerrrrSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn will
  124.      return DM_SUCCESS if successful, or will return DM_FAILURE if it fails.
  125.      ddddmmmmPPPPMMMMBBBBuuuuffffffffeeeerrrrEEEExxxxeeeeccccuuuutttteeeeVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn will return DM_SUCCESS if successful, or
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ddddmmmmPPPPMMMMSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn((((3333ddddmmmm))))                    ddddmmmmPPPPMMMMSSSSeeeettttuuuuppppVVVViiiiddddeeeeooooTTTTrrrraaaannnnssssiiiittttiiiioooonnnn((((3333ddddmmmm))))
  137.  
  138.  
  139.  
  140.      will return DM_FAILURE if it fails.
  141.  
  142.  
  143. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  144.      dmPMCreateManager(3dm), dmPMCreateEffect(3dm), dmGetError(3dm).
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.